home *** CD-ROM | disk | FTP | other *** search
/ Speccy ClassiX 1998 / Speccy ClassiX 98.iso / amiga_system / the_aminet / comm / fido / gfreq23.lha / GFreq2.3 / Docs / GoldFreq_ENG.doc < prev    next >
Text File  |  1995-10-20  |  19KB  |  450 lines
  1.  
  2.     GoldFreq version 2.3
  3.     
  4.     GoldFreq is shareware and copyright 1994 and 1995 Jari Kanerva.
  5.     The author can be reached at Fidonet 2:201/411.73
  6.     e-mail jari@canit.se
  7.  
  8.     You will always find the latest version of GoldFreq for filerequest
  9.     from FLOATER's BBS 2:203/160.0 Magic name GoldFreq.
  10.  
  11.         Introduction:
  12.     GoldFreq is a FidoNet-compatible filerequest server. It has nodelist
  13.     support. Sends Netmail or response file to the freqqing system.
  14.     Supports Softlinks. Checks that volymes in exists before
  15.     trying to use them to avoid the DOS-requester "Please insert
  16.     Volyme xx in any drive." The user may send a testfreq to check if the
  17.     file is on the base and the time it would take to download it.
  18.     GoldFreq handles points, magicfiles, updatefreq's, userlevels, password's
  19.     and much more. If GoldFreq's old window is still open, GoldFreq will
  20.     find it and use it. GoldFreq can handle filenames with spaces.
  21.  
  22.     The registered version has also
  23.     Special password's for the sysop and possibility to make statistics.
  24.     You may use %-kodes in the netmail and rspfiles.
  25.  
  26.     All configuration keywords and features are explained later in this
  27.     document.
  28.     
  29.     GoldFreq is shareware, and may be distributed in a non-commercial way
  30.     (you may copy, spread, and use it but don't make money out of it).
  31.  
  32.     The programmer take no responsibility for eventual errors that the
  33.     program may create in any way. You run it on your own risk. I have
  34.     done everything I can to assure that it functions correctly. Many hours
  35.     of testing and debugging have been done. (If you still find any bugs,
  36.     please report).
  37.  
  38.     The keyfile that You get when You register is commercial and strictly
  39.     personal and may not be spread.
  40.  
  41.     I have only tested GoldFreq with TrapDoor, but it work just as fine
  42.     with other similar programs.
  43.     GoldFreq nedds a few arguments from TrapDoor when it is started.
  44.     If You use Trapdoor then put in the line
  45.     FREQUEST "GoldFreq %i %o %O %B \"%S\" %n" in TrapDoor.cfg or if You not have
  46.     the coniguration file in "Mail:" then use the line
  47.     FREQUEST "GoldFreq %i %o %O %B \"%S\" %n c=<path/cfgfile>" in TrapDoor.cfg
  48.     %i = The name of the .req file.
  49.     %o = The name of the .rlo file.
  50.     %O = The path to your outbound directory.
  51.     %B = The actual connect speed.
  52.     %S = The name of the sysop that sends the request.
  53.     %n = The Fidonet-address of the requesting system.
  54.     OBS If You don't have the programm-file GoldFreq in your path You must
  55.     put the filepath in TrapDoor.cfg.
  56.     Ex: FREQUEST "mail:bin/GoldFreq %i %o %O %B \"%S\" %n"
  57.  
  58.     To be able to check if the requesting node is in the nodelist. GoldFreq
  59.     needs the traplist compilled nodelist and traplist.library version 5 or
  60.     above
  61.  
  62.     TrapDoor is copyright Maximilian Hantsch and Martin Laubach.
  63.     
  64.     GoldFreq is offered to you under the concepts of ShareWare. You can
  65.     use it for an evaluation period of up to 30 days without paying any
  66.     charge. If you are going to use GoldFreq after the evaluation period,
  67.     you should register.
  68.  
  69.     Taglines, Syspass, FileAccounting, AllMagic, Possibility to specify
  70.     multiple files with the same magicname and to use wildcard in the
  71.     magicfiles are only possible in the registered version.
  72.     You may send max 3 files with the unregistered version.
  73.  
  74.     You can register by sending 100 SEK or 15 US$ to:
  75.         Jari Kanerva
  76.         PR
  77.         163 08 Spanga
  78.         SWEDEN
  79.     In Sweden You can use POSTGIRO: 836 86 57 - 6, 100 SEK.
  80.     Please state your full name and address. Your fidonetaddres and that
  81.     you wish to register GoldFreq.
  82.     I will make a fileattatch with your keyfile to the fidonetaddres you
  83.     give me. Or if it don't succed I will UUEncode it in a Netmail to You.
  84.  
  85.     The keyfile that you get when you register is commercial and may not
  86.     be spread. If you sell your keyfile you are not allowed to keep any
  87.     copy of the keyfile.
  88.     GoldFreq.key must be in the same directory as the file GoldFreq or in
  89.     Mail:
  90.  
  91.     The %-commands can bee used in "HEADER", "FIRSTCALL" and all
  92.     "FAIL*"-letters.
  93.     %a = The freqqer's name.
  94.     %b = The freqer's nodenumber.
  95.     %c = Date
  96.     %d = Clock
  97.     %e = Connect-speed
  98.     %f = Calculated transferspeed. (cps)
  99.     %g = The First name of the sysop that sends the request.
  100.     %h = Calculated kb/mb that can be freqqed with the actual connect
  101.          and the time limit. (If timelimit is used.)
  102.     %i = The timelimit. (If timelimit is used.)
  103.     %% = a Procentsign
  104.     The %-commands are not case sensitive.
  105.     The %-commands are only available in the registered version.
  106.  
  107.     I wish to thank (in alphabetic order).
  108.     Mathias Axelsson
  109.     Christian Carlsson
  110.     Kjell Cederfeld
  111.     Bosse Soderholm
  112.  
  113. ===========================================================================
  114.  
  115.  
  116.         Let's take a look at the configuration file.
  117.  
  118.         Keyword: SYSOP <Name>
  119.     Here you just write your own name.
  120.     Ex: SYSOP Jari Kanerva
  121.  
  122.         Keyword: NODE <nodenummer>
  123.     Here you write your fidonetadress. It must be your full 4d
  124.     fidonetaddress.
  125.     Ex: NODE 2:203/319.7
  126.  
  127.         Keyword: SYSTEM <name>
  128.     This is the name of your system/BBS.
  129.     Ex: SYSTEM The Cybers Heaven
  130.  
  131.         Keyword: (NO)FILEACC
  132.     If You wish to keep accounting on how many times each file has been
  133.     requested. It will also be writen in the netmail or the responsfile.
  134.     This require that ACCPATH <dir> is set.
  135.     This works only on the registered version.
  136.     Ex: FILEACC
  137.  
  138.         Keyword: (NO)ACCPATH <dir>
  139.     If You wich to keep accounting of how much each node freq from You.
  140.     Then you have to give GoldFreq a path where it can keep its accounting
  141.     files.
  142.     Ex: ACCTPATH  Mail:GFreq/Accounts
  143.  
  144.         Keyword: (NO)LOGFILE <file>
  145.     Tell GoldFreq what to call its logfile.
  146.     Ex: LOGFILE Mail:GFreq/GFreq.Log
  147.  
  148.         Keyword: (NO)NODELIST <dir>
  149.     Tell GoldFreq where to find the nodelist.
  150.     Ex: NODELIST Mail:Nodelist
  151.  
  152.         Keyword: DATABASE <dir>
  153.     This is a directory that GoldFreq needs for its internal files.
  154.     Ex: DATABASE mail:GFreq/Database
  155.  
  156.         Keyword: WORKDIR <dir>
  157.     This is the directory where Goldfreq can put its temporary files.
  158.     Ex: WORKDIR T:
  159.  
  160.         Keyword: (NO)WILDCARDS
  161.     Give the freqqing system the possibility to use WildCards (#? or *).
  162.     Only files found in the CD lists will be sent. 
  163.     Ex in the freqfile: a* (will send all files starting with the letter a)
  164.     Ex in the config: WILDCARDS
  165.  
  166.         Keyword: (NO)TESTFREQ
  167.     Give the freqqer the possibility to send a testfreq. He/she may write
  168.     "%TEST" on the first line in the freqfile if he/she just wish to check
  169.     if the file is available and to see the transfer time.
  170.     Ex in the freqfile: "%TEST"
  171.     Ex in the config: TESTFREQ
  172.  
  173.         Keyword: (NO)LOCALMSG
  174.     Tell GoldFreq to send a Netmail to the requesting node. With among
  175.     other things the result to the filerequest.
  176.     Ex: LOCALMSG
  177.  
  178.         Keyword: (NO)RSP
  179.     Tell GoldFreq to send a response file instead of the netmail.
  180.     Ex: RSP
  181.  
  182.         Keyword: (NO)HEADER <file>
  183.     File to get the netmail or rspfile header from. In the header file you
  184.     should put some information of your system.
  185.     Ex: HEADER Mail:GFreq/GFreq.Header
  186.  
  187.         Keyword: (NO)FIRSTCALL <file>
  188.     Select a firstcall file to send to those nodes that request files for
  189.     the first time. Telling more abaut your system than the header file.
  190.     Ex: FIRSTCALL Mail:GFreq/textfiles/FirstTime.TXT
  191.  
  192.         Keyword: (NO)TAGS <file>
  193.     Tell GoldFreq that you wish to use taglines. And where to look for
  194.     them.
  195.     If the tagline contains "\n" then there will be an newline in the
  196.     letter.
  197.     This works only on the registered version.
  198.     Ex: TAGS Mail:Gfreq/Tags
  199.  
  200.         Keyword: (NO)STOPFREQ <stop> <start>
  201.     Specify when freqs are not allowed. You can specify more than one
  202.     STOPFREQ.
  203.     Ex: STOPFREQ 16:12 16:45
  204.     Ex: STOPFREQ 02:00 03:00
  205.  
  206.         Keyword: FAILSTOPFREQ <file>
  207.     Specify textfile to send to failed filerequests due to the STOPFREQ
  208.     option.
  209.     Ex: FAILSTOPFREQ mail:GFreq/Textfiles/FailStopFreq.TXT
  210.  
  211.         Keyword: (NO)SYSPASS <password/file>
  212.     This is a special password for the sysop. By using the SYSPASS the
  213.     sysop may request files that do not exist in the areas specified in
  214.     GoldFreq.cfg or request files from nodes that normaly are not allowed
  215.     to make filerequests. You may choose one alltime password by putting
  216.     the password in GoldFreq.cfg or select a file to get the password from
  217.     by just putting <path/file> in GoldFreq.cfg. If you choose to have the
  218.     file then you can use each password just once. When the password is
  219.     used GoldFreq marks it with a space before the password so that it
  220.     can't be used again before the space is removed manually. When the
  221.     first password is marked used GoldFreq selects the second and so on.
  222.     When al the passwords in the file is used then you won't be able to use
  223.     SYSPASS again until you have remowed the spaces and marked the
  224.     passwords unused again.
  225.     After three failed attempts to use SYSPASS GoldFreq puts a file named
  226.     NOSYSPASS in the directory you have specified as DATABASE. As long as
  227.     the file is there you won't be able to use syspass. The file must be
  228.     removed manually.
  229.     if you send two failed SYSPASS and then one succesfull the counting
  230.     starts from zero and you have three atempts again.
  231.     In the requestfile you shall write:
  232.     On the first line you must write: SYSPASS <yourpassword>
  233.     On the foliwing lines you can write like a normal filerequest if the
  234.     files are in some of the paths specified in Goldfreq.cfg otherwise if
  235.     the files are some where else. Then you must write the whole path to
  236.     the file.
  237.     This works only on the registered version.
  238.     Ex cfg: SYSPASS Mail:GFreq/PassWords
  239.     Ex cfg: SYSPASS My_password_is_secret
  240.     Ex Freq: SYSPASS My_password_is_secret
  241.              s:startup-sequence
  242.              GoldFreq
  243.  
  244.         Keyword: (NO)FAILSYSPASS <file>
  245.     Textfile to send to those who try to use SYSPASS but fails.
  246.     Ex: FAILSYSPASS mail:GFreq/Textfiles/FailSys.TXT
  247.  
  248.         Keyword: (NO)POINTS
  249.     Allow points to make filerequests.
  250.     Ex: POINTS
  251.  
  252.         Keyword: (NO)FAILPOINT <file>
  253.     Path to textfile to send for failed requests due to NOPOINT option.
  254.     Disable or set NOFAILPOINT if you don't wish to use this.
  255.     Ex: FAILPOINT mail:GFreq/Textfiles/Point.TXT
  256.  
  257.         Keyword: (NO)UNLISTED
  258.     Allow nodes not listed in the nodelist or your private pointlist to
  259.     request files.
  260.     Ex: UNLISTED
  261.  
  262.         Keyword: (NO)FAILUNLISTED <file>
  263.     Path to textfile to send for failed requests due to NOUNLISTED option.
  264.     Disable or set NOFAILUNLISTED if you don't wish to use this.
  265.     Ex: FAILUNLISTED Mail:GFreq/Textfiles/Unlisted.TXT
  266.  
  267.         Keyword: (NO)ONLYKNOWN
  268.     Only allow nodes listed with ALLOWNODE to make file requests.
  269.     Ex: ONLYKNOWN
  270.  
  271.         Keyword: (NO)FAILONLYKNOWN <file>
  272.     Path to textfile to send for failed requests due to ONLYKNOWN option.
  273.     Disable or set NOFAILONLYKNOWN if you don't wish to use this.
  274.     Ex: FAILONLYKNOWN Mail:GFreq/Textfiles/Security.TXT
  275.  
  276.         Keyword: EXCLUDE <node>
  277.     Forbid specified nodes from making file requests. You may use
  278.     wildcards (*).
  279.     Ex: EXCLUDE 1:234/567.8
  280.     Ex: EXCLUDE 55:100/*
  281.  
  282.         Keyword: (NO)FAILEXCLUDE <file>
  283.     Path to textfile to send for failed requests due to EXCLUDE'd node.
  284.     Disable or set NOFAILEXCLUDE if you don't wish to use this.
  285.     Ex: FAILEXCLUDE Mail:GFreq/Textfiles/Exclude.TXT
  286.  
  287.         Keyword: (NO)BEEP
  288.     Beep and flash the screen when GoldFreq starts.
  289.     Ex: BEEP
  290.  
  291.         Keyword: SCREEN <pubscreen>
  292.     Define public screen name to open status window on (WB 2.04+)
  293.     If you wish to use TrapDoor's public screen then you have to put
  294.     in "SCREENMODE PUBLIC" in TrapDoor.cfg
  295.     Ex: SCREEN TrapDoor
  296.  
  297.         Keyword: (NO)SCREENTOFRONT
  298.     Tell GoldFreq to put his screen to front. This does only work if the
  299.     option NOQUIET is selected.
  300.     Ex: SCREENTOFRONT
  301.  
  302.         Keyword: (NO)WINDOW <CON:xx>
  303.     Opens a CON: window on the selected screen.
  304.     Ex: WINDOW CON:100/50/450/150/GoldFreq 1.8
  305.     Ex: WINDOW CON:100/50/450/150/GoldFreq 1.7/Close/wait
  306.  
  307.         Keyword: (NO)DEFCOMMENT <desc>
  308.     Define default file comment to use if GoldFreq don't find any.
  309.     Ex: DEFCOMMENT No File Description Available :-(
  310.  
  311.         Keyword: (NO)FISH
  312.     For Fish CD users: Have Gold Freq use the Fish CD style file comments.
  313.     It is one file named <file>.pi in the same directory as the actual file.
  314.     But first GoldFreq search for the AmigaDos filecomment.
  315.     Ex: FISH
  316.  
  317.         Keyword: (NO)AMINET
  318.     For those that has AmiNet. With the descriptions in a .readme file.
  319.     But first GoldFreq search for the AmigaDos filecomment.
  320.     Ex: AMINET
  321.  
  322.         Keyword: (NO)PRODUCT-INFO
  323.     If GoldFreq don't find the AmigaDos filecomment. Tell it to search for
  324.     the file Product-Info inside the archive.
  325.     Ex: PRODUCT-INFO
  326.  
  327.         Keyword: PASSDEFSEND <file>
  328.     Define a file to send with all successful file requests.
  329.     Max 6 PassDefsend's.
  330.     Ex: PASSDEFSEND Files:Lokala/Text/NewFiles.lha
  331.  
  332.         Keyword: FAILDEFSEND <file>
  333.     Define a file to send with all file requests that failed the security
  334.     check. Max 6 FailDefsend's.
  335.     Ex: FAILDEFSEND Files:Lokala/Text/BBSRules.lha
  336.  
  337.         Keyword: (NO)MAXTIME <min>
  338.     You can speicfy the max allowed time for a freq. This is so those with only
  339.     a 2400 modem cant pick upp as much files as those with 14400 or 28800
  340.     modems. Then your thelephoneline will not be occupied for to long.
  341.     The argument after MAXTIME is in minutes.
  342.     Ex: MAXTIME 5
  343.  
  344.         Keyword: (NO)TIMEPASS <password>
  345.     This password is to make it possible ta allow somebody to pick up more
  346.     bytes than their connect speed allows in MAXTIME. The use of SYSPASS in the
  347.     freqfile aways disables the MAXTIME counting. You shall not use both
  348.     TIMEPASS and SYSPASS in the freqfile.
  349.     TIMEPASS must be first in the freqfile and start with the word TIMEPASS
  350.     followed by the password. It is not case sensetive.
  351.     Ex in the freqfile:   TIMEPASS For_Ever (in the first line)
  352.     Ex in the configfile: TIMEPASS For_Ever
  353.  
  354.         Keyword: (NO)MAXBYTES
  355.     Set the maximum bytes allowed per file request.
  356.     Disable or set NOMAXBYTES for unlimited.
  357.     Ex: MAXBYTES 10m  (10 Mb = 10 * 1024 * 1024 bytes)
  358.     Ex: MAXBYTES 50k  (50 Kb = 50 * 1024 bytes)
  359.     Ex: MAXBYTES 500b (500 bytes)
  360.     Ex: MAXBYTES 1254 (1254 bytes)
  361.  
  362.         Keyword: (NO)MAXFILES
  363.     Set the maximum files allowed per file request.
  364.     Disable or set NOMAXFILES for unlimited.
  365.     Ex: MAXFILES 10
  366.  
  367.         Keyword: MAXLEVEL <level> FILES <files> BYTES <bytes>
  368.     Choose diferent maxbytes and maxfiles for the different userlevels.
  369.     Ex: MAXLEVEL 2 FILES 20 BYTES 10m
  370.  
  371.         Keyword: ALLOWNODE <node> [LEVEL/ONLY <level>]
  372.     Define nodes that are allowed to request files when ONLYKNOWN  mode is
  373.     active. Also allows you set access levels for nodes for use with or
  374.     without ONLYKNOWN mode.
  375.     If a node is specified under ALLOWNODES then no other security-checks
  376.     are performed for that node. You may set EXCLUDE 1:234/* to tell
  377.     GoldFreq that nodes from net 1:234 are forbid from filerequests. Then
  378.     you may specify ALLOWNODE 1:234/567.5 to tell GoldFreq that just that
  379.     special node are allowed. You may also use wildcards in ALLOWNODE. 
  380.     ALLOWNODE 2:201/411.* LEVEL 5 gives all the points under 2:201/411 the
  381.     userlevel 5.
  382.     You may also specify acceslevels for the nodes.
  383.     Nodes with LEVEL 5 are allowed to pick up magicfiles and files from
  384.     directorys with level 0-5.
  385.     Nodes with ONLY 6 are only allowed to pick upp magicfiles and files
  386.     from directorys with level 6.
  387.     Ex: ALLOWNODE 1:123/456.0 LEVEL 5
  388.     Ex: ALLOWNODE 1:123/456.8 ONLY 5
  389.     Ex: ALLOWNODE 2:203/319.7
  390.     Ex: ALLOWNODE 2:201/411.* LEVEL 5
  391.  
  392.         Keyword: (NO)DEFPOINTLEVEL <num>
  393.     Set default level for points not found under allownode.
  394.     Ex: DEFPOINTLEVEL 1
  395.  
  396.         Keyword: (NO)DEFNODELEVEL <num>
  397.     Set default level for nodes not found under allownode.
  398.     Ex: DEFNODELEVEL 2
  399.  
  400.         Keyword: (NO)UPDATE
  401.     Allow update requests.
  402.     File after date = +yymmdd and file before date = -yymmdd.
  403.     In the requestfile it must be writen after the filename with a space
  404.     between the filename and the date.
  405.     Ex: UPDATE
  406.  
  407.         Keyword: ALLMAGIC <name> <file>
  408.     Define magic filenames that are free for all to request. also those
  409.     nodes that normaly not are allowed to request files. Except from those
  410.     nodes that are specified under EXCLUDE.
  411.     This works only on the registered version.
  412.     Ex: ALLMAGIC NEWFILES Files:Lokala/Text/NewFiles.lha
  413.  
  414.         Keyword: MAGIC <name> <file> [<level><password>]
  415.     Define magic filenames. Optional password and access levels may be
  416.     assigned. Passwords in the .req-file must start with a '!'-sign. The
  417.     '!'-sign is not nessesary in the .cfg-file.
  418.     Ex in the .req-file: Spot !Secret
  419.     Wildcarding is allowed in the filename in the registered version
  420.     the newest matching file will be sent.
  421.     You do not have to specify files under both MAGIC and ALLMAGIC.
  422.     Ex: MAGIC FILES Files:Local/Text/AllFiles.lha
  423.     Ex: MAGIC Spot Files:Local/Utils/spot.lha PASSWORD WHO_KNOWS LEVEL 5
  424.     Ex: MAGIC BARNEY Files:ADS/AdsFido/BARNEY* LEVEL 1
  425.     Ex: MAGIC GFreq Files:Locala/Utils/GFreq*
  426.     You can also in the registered version write multiple files with the
  427.     same MAGIC-name. Then all files with the same MAGIC-name will be sent.
  428.     Ex: MAGIC Spot Files:Lokala/Utils/SPOT13.lha
  429.     Ex: MAGIC Spot Files:Lokala/Utils/SPOT13p.lha
  430.     In this case both files will be sent.
  431.  
  432.         Keyword: (NO)CDFIRST
  433.     Tell GoldFreq to search the databases before the DIRECTORY's
  434.     Ex: CDFIRST
  435.  
  436.         Keyword: CD <database>
  437.     Specify the names of the databases to search for the file. If GoldFreq
  438.     finds the file it will check that the volyme exists before trying to
  439.     read the file.
  440.     Ex: CD AmiFiles
  441.  
  442.         Keyword: DIRECTORY <dir>
  443.     Define directories for Gold Freq to search through for files to send.
  444.     You may add passwords or access levels as needed.
  445.     Ex: DIRECTORY Files:Local/Diffs
  446.     Ex: DIRECTORY Files:SKY/Shi_Tns PASSWORD Amiga LEVEL 5
  447.     Ex: DIRECTORY Files:ADS/AdsARexx LEVEL 4
  448.     Ex: DIRECTORY Files:ADS/AdsComm PASSWORD !!--
  449.  
  450.